Lint messages reported from porter should not mention mixins #2992
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Kim Christensen <kimworking@gmail.com>
Signed-off-by: Kim Christensen <kimworking@gmail.com>
kichristensen
requested review from
schristoff,
sgettys,
bdegeeter and
troy0820
as code owners
schristoff
reviewed
Feb 15, 2024
pkg/linter/linter.go
Outdated
| @@ -111,8 +111,12 @@ type Location struct { | |||
| } | |||
|
|
|||
| func (l Location) String() string { | |||
| return fmt.Sprintf("%s: %s step in the %s mixin (%s)", | |||
| l.Action, humanize.Ordinal(l.StepNumber), l.Mixin, l.StepDescription) | |||
| mixin := "" | |||
There was a problem hiding this comment.
Looking at the original issue, I think the logic should be something along the lines of if the mixin name is "", we should not be returning a string. Let me know if you are reading that from #2526
There was a problem hiding this comment.
You are complety correct, I will work on the change
There was a problem hiding this comment.
@schristoff It has been changed now to align with your comment
Signed-off-by: Kim Christensen <kimworking@gmail.com>
schristoff
approved these changes
Feb 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change
When porter generates a lint message directly, instead of the message coming from a mixin, we should change the message so that it doesn't print out extra "empty" text about mixins that isn't relevant.
What issue does it fix
Closes #2526
Notes for the reviewer
There is a stale PR, #2530, for the same issue.
Checklist
Reviewer Checklist